Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adopt the centralized Xanadu Sphinx Theme #215

Merged
merged 19 commits into from
May 5, 2022
Merged

Conversation

rmoyard
Copy link
Contributor

@rmoyard rmoyard commented May 4, 2022

Context:
Currently, all Xanadu OSS projects include their own version of the Xanadu Sphinx theme; however, the Xanadu Sphinx Theme repository is now publicly available and is the preferred way to access the Xanadu CSS theme and Sphinx directives.

Description of the Change:

Deleted the doc/xanadu_theme directory.
Updated doc/requirements.txt and doc/conf.py to reference and use the (centralized) Xanadu Sphinx Theme.
Benefits:

The size of this repository is smaller, meaning git clone will run faster.
Updates to the Xanadu Sphinx theme no longer have to be manually ported to this repository.

Possible Drawbacks:
None.

@codecov
Copy link

codecov bot commented May 4, 2022

Codecov Report

Merging #215 (de81435) into master (9084049) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #215   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          292       292           
=========================================
  Hits           292       292           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9084049...de81435. Read the comment docs.

Copy link
Contributor

@Mandrenkov Mandrenkov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, @rmoyard! 🎉

I just have a few minor comments on some of the changes.

doc/overview.rst Outdated Show resolved Hide resolved
doc/overview.rst Outdated Show resolved Hide resolved
doc/directives.py Outdated Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
@rmoyard rmoyard requested a review from Mandrenkov May 5, 2022 14:39
Copy link
Contributor

@Mandrenkov Mandrenkov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good to me! 🥳

@rmoyard rmoyard merged commit f1d5ff7 into master May 5, 2022
@rmoyard rmoyard deleted the adopt_xanadu_sphinx branch May 5, 2022 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants